Add notes about paging commands not working with minibuffer
authorJustin Burkett <justin@burkett.cc>
Tue, 5 Dec 2017 12:17:47 +0000 (07:17 -0500)
committerJustin Burkett <justin@burkett.cc>
Tue, 5 Dec 2017 12:17:47 +0000 (07:17 -0500)
README.org
which-key.el

index 9ad7cb107d455fdf03032c3419a4aade604031c7..edde2a4788b92ca068bc257a18f772c24af6118c 100644 (file)
     [[./img/which-key-minibuffer.png]]
     
     Note the maximum height of the minibuffer is controlled through the built-in
-    variable =max-mini-window-height=.
+    variable =max-mini-window-height=. Also, the paging commands do not work
+    reliably with the minibuffer option. Use the side window on the bottom
+    option if you need paging.
     
 ** Additional Commands
    - =which-key-show-top-level= will show most key bindings without a prefix. It
index 348f50d9e23167558473821daa20987b2eeb0a6d..79f7affd852559cf2318a8ad46a5802e400ae915 100644 (file)
@@ -778,7 +778,10 @@ bottom."
 
 ;;;###autoload
 (defun which-key-setup-minibuffer ()
-  "Apply suggested settings for minibuffer."
+  "Apply suggested settings for minibuffer.
+Do not use this setup if you use the paging commands. Instead use
+`which-key-setup-side-window-bottom', which is nearly identical
+but more functional."
   (interactive)
   (which-key--setup-echo-keystrokes)
   (setq which-key-popup-type 'minibuffer